Rainbow Android SDK/com.ale.rainbowsdk/Routing

Routing

interface Routing

Types

Companion

object Companion

ICliChangeListener

interface ICliChangeListener

IForwardStatusChangeListener

interface IForwardStatusChangeListener

IGetRoutineListener

interface IGetRoutineListener

Interface to get a routine. Only for Cloud PBX.

INomadicStatusChangeListener

interface INomadicStatusChangeListener

IRingingDevicesChangeListener

interface IRingingDevicesChangeListener

ITelephonyServicesChangeListener

interface ITelephonyServicesChangeListener

Properties

busyForwardStatus

abstract val busyForwardStatus: ForwardStatus?

Get the current Forward status, when you are busy, allowing you to know the destination of your PBX calls. Only for Cloud PBX.

cliOptions

abstract val cliOptions: List<CLIOptions>?

Get the list of all CLI Options available for the user. Only for Cloud PBX.

clirStatus

abstract val clirStatus: Boolean

Get the CLIR status.

forwardStatus

abstract val forwardStatus: ForwardStatus?

Get the current Forward status allowing you to know the destination of your PBX calls.

isDefaultOverflowActivated

abstract val isDefaultOverflowActivated: Boolean

Check if the user has a default overflow activated or not (a forward for BUSY or NO_ANSWER). This is configured at Company level. Only for Cloud PBX.

isMediaPillarRegistered

abstract val isMediaPillarRegistered: Boolean

Check if VoIP is up and running (the user will be able handle PBX calls through VoIP).

isMonolineIncomingMode

abstract val isMonolineIncomingMode: Boolean

Check if second incoming call should be presented to the user or not. Only for Cloud PBX.

isMultiDevicesUser

abstract val isMultiDevicesUser: Boolean

Check if user has more than one device or not. Only for Cloud PBX.

isNomadicActivatedOnMediapillar

abstract val isNomadicActivatedOnMediapillar: Boolean

Check if the current nomadic state will let the PBX join the current device running the application through VoIP. Always true for Cloud PBX.

isNomadicActivatedOnMyMobile

abstract val isNomadicActivatedOnMyMobile: Boolean

Check if the current nomadic state will let the PBX join the current device running the application through VoIP or GSM. Always true for Cloud PBX.

isNomadicDeactivatedOnMyMobile

abstract val isNomadicDeactivatedOnMyMobile: Boolean

Check if the current nomadic state will not let the PBX join the current device running the application Always false for Cloud PBX.

noAnswerForwardStatus

abstract val noAnswerForwardStatus: ForwardStatus?

Get the current Forward status, when you are not answering, allowing you to know the destination of your PBX calls. Only for Cloud PBX.

nomadicStatus

abstract val nomadicStatus: NomadicStatus?

Get the current Nomadic status allowing you to know the destination of your PBX calls. Always null for Cloud PBX.

overflowForwardStatus

abstract val overflowForwardStatus: ForwardStatus?

Get the current overflow forward status allowing you to know the destination of your PBX calls when you are disconnected.

ringingActivated

abstract val ringingActivated: Boolean

Get the ringing status. Only for OXE PBX.

routinesList

abstract val routinesList: ArrayItemList<Routine>

Get the list of available routines. The returned object is an ArrayItemList so you can listen to its changes. Only for Cloud PBX.

Functions

activateNomadic

abstract fun activateNomadic(phoneNumber: String?)

Activate the nomadic on the specified number. Only for Hybrid PBX.

activateRoutine

abstract fun activateRoutine(routineId: String, listener: RainbowListener<Unit, Unit>)

Activate a routine from its id. Only for Cloud PBX.

areAllDevicesRinging

abstract fun areAllDevicesRinging(): Boolean

Check if all user devices are ringing for incoming calls. Only for Cloud PBX.

cancelForward

abstract fun cancelForward(forwardType: ForwardType)

Cancel automatic call forwarding depending on the given ForwardType (BUSY or NO_ANSWER are only for Cloud PBX).

cancelManagerForward

abstract fun cancelManagerForward(jid: String)

Cancel automatic call forwarding for Manager. Only for Hybrid PBX.

createRoutine

abstract fun createRoutine(name: String, listener: RainbowListener<Routine, Unit>)

Create a new routine with the given name.

deactivateNomadic

abstract fun deactivateNomadic()

Deactivate the nomadic. Only for Hybrid PBX.

deleteRoutine

abstract fun deleteRoutine(routine: Routine, listener: RainbowListener<Unit, Unit>)

Delete a routine.

forwardManagerToNumber

abstract fun forwardManagerToNumber(jid: String, number: String?)

Activate automatic call forwarding for Manager to the given number. Only for Hybrid PBX.

forwardManagerToVoiceMail

abstract fun forwardManagerToVoiceMail(jid: String)

Activate automatic call forwarding for Manager to the voicemail. Only for Hybrid PBX.

forwardToNumber

abstract fun forwardToNumber(number: String?, internal: Boolean, type: ForwardType)

Activate automatic call forwarding to the given number and depending on the given ForwardType (BUSY or NO_ANSWER are only for Cloud PBX).

forwardToVoiceMail

abstract fun forwardToVoiceMail(type: ForwardType)

Activate automatic call forwarding to the voicemail depending on the given ForwardType (BUSY or NO_ANSWER are only for Cloud PBX).

forwardToWelcomeService

abstract fun forwardToWelcomeService(welcomeServiceId: String, type: ForwardType)

Activate automatic call forwarding to the given welcome service and depending on the given ForwardType. Only for Cloud PBX

getActiveRoutine

abstract fun getActiveRoutine(): Routine?

Return the active routine, if there is one, null otherwise.

getDeviceNumber

abstract fun getDeviceNumber(): String?

Get the device GSM phone number (SIM1) if any and if readable. Some carriers are not allowing the phone number read from SIM card.

getManagerForwardStatus

abstract fun getManagerForwardStatus(jid: String): ForwardStatus?

Get the current Manager Forward status allowing you to know the destination of his PBX calls.

getNomadicNumber

abstract fun getNomadicNumber(withMediapillar: Boolean): String?

Get the nomadic number to use to activate nomadic.

getRoutineById

abstract fun getRoutineById(routineId: String, listener: Routing.IGetRoutineListener)

Get a specific routine from its id. As the result may be asynchronous, it is returned in the listener. Only for Cloud PBX.

getSelectedCliOption

abstract fun getSelectedCliOption(): CLIOptions?

Get the current selected CLI Options for the user. Only for Cloud PBX.

hasMediaPillar

abstract fun hasMediaPillar(): Boolean

Check if the user has access to VoIP for PBX calls.

hasTelephonyServices

abstract fun hasTelephonyServices(): Boolean

Check if telephony services are up and running (the user will be able handle PBX calls).

modifyRoutine

abstract fun modifyRoutine(routine: Routine, listener: RainbowListener<Unit, Unit>)

Modify a routine. Only for Cloud PBX.

registerCliChangeListener

abstract fun registerCliChangeListener(listener: Routing.ICliChangeListener)

registerForwardStatusChangeListener

abstract fun registerForwardStatusChangeListener(listener: Routing.IForwardStatusChangeListener)

registerNomadicStatusChangeListener

abstract fun registerNomadicStatusChangeListener(listener: Routing.INomadicStatusChangeListener)

registerRingingDevicesChangeListener

abstract fun registerRingingDevicesChangeListener(listener: Routing.IRingingDevicesChangeListener)

registerTelephonyServicesChangeListener

abstract fun registerTelephonyServicesChangeListener(listener: Routing.ITelephonyServicesChangeListener)

retrieveForwardStatus

abstract fun retrieveForwardStatus()

Manually refresh the forward status from server.

retrieveNomadicStatus

abstract fun retrieveNomadicStatus()

Manually refresh the nomadic status from server for Hybrid PBX only.

selectCli

abstract fun selectCli(cliOption: CLIOptions)

Select the new CLI Options to use for identifying external outgoing calls. Only for Cloud PBX.

unregisterCliChangeListener

abstract fun unregisterCliChangeListener(listener: Routing.ICliChangeListener)

Unregister the listener on the CLI options change

unregisterForwardStatusChangeListener

abstract fun unregisterForwardStatusChangeListener(listener: Routing.IForwardStatusChangeListener)

Unregister the listener on the forward change

unregisterNomadicStatusChangeListener

abstract fun unregisterNomadicStatusChangeListener(listener: Routing.INomadicStatusChangeListener)

Unregister the listener on the nomadic change

unregisterRingingDevicesChangeListener

abstract fun unregisterRingingDevicesChangeListener(listener: Routing.IRingingDevicesChangeListener)

Unregister the listener on the ringing devices change. Only for Cloud PBX.

unregisterTelephonyServicesChangeListener

abstract fun unregisterTelephonyServicesChangeListener(listener: Routing.ITelephonyServicesChangeListener)

Unregister the listener on the telephony services change

updateClirStatus

abstract fun updateClirStatus(clirStatus: Boolean)

Set the new CLIR status. On true, it overrides the CLI option defined and use an anonymous identity for external outgoing calls.

updateRingingActivated

abstract fun updateRingingActivated(ringingActivated: Boolean)

Set the new ringing status. On true, it overrides the ringing option defined and lets deskPhone ring on incoming calls. Only for OXE PBX.

updateRingingDevices

abstract fun updateRingingDevices(webRTCOnly: Boolean)

Update ringing devices by activating only VoIP or not. Only for Cloud PBX.